Scripting > CxHmiFms > CxFmsConfigCtrl Object > CxFmsConfigCtrl Properties

CxFmsConfigCtrl Properties

The CxFmsConfigCtrl object contains the following properties.

General Properties

Browse by letter:     A     B     C     D     E     F     I     P     S     U    

Property SubType Read Only Description

Appearance

Integer

No

Returns/sets the appearance of the object boundary.

Possible values for this property are as follows.

  • 0 – Flat
  • 1 – 3D

Default value is 0 - Flat

BeginDate

String

No

Returns/sets the starting date of the FMS Configuration control.

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is T-7

BorderStyle

Integer

No

Returns/sets the border style.

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed single border

Default value is 0 - None

ChooserFilterString

String

No

Returns/sets the filter to be used when retrieving Nodes.  Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place.

Example

A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test".

Default value is * (multiple character wildcard)

ChooserFilterType

Integer

No

Returns/sets the Node property that will be filtered by the string specified in the ChooserFilterString property.

Possible values for this property are as follows.

  • 0 – Name
  • 1 – Description
  • 2 – ID

Default value is 0 - Name

ChooserGroupSelection

String

No

Returns/sets the group currently selected in the Node chooser’s Group combo box.

ChooserPrimarySortColumn

Integer

No

Returns/sets the primary sort column of the Node chooser’s Node list.

Possible values for this property are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Default value is 2 - Name ascending

ChooserSiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the Node chooser’s FMS service combo box.

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS service combo box is visible.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

CmdDefinitionXml

String

No

Returns/sets the XML specifying the custom FMS commands configured for the control.  Another way to configure this property is to use the control’s property page.

ColumnsXml

String

No

Returns/sets the XML specifying the columns that will be displayed in the FMS Configuration control, for either data view

Another way to configure this property is to use the control-specific property page in the CygNet FMS Control Properties dialog box. See CygNet FMS Configuration Control for more information.

ConfigRecSourceFilter

Integer

No

Returns/sets the source of Node configuration data.

Possible values for this property are as follows.

  • 1 – Device
  • 2 – Import
  • 3 – File
  • 8 – Event
  • 9 – System
  • 10 – Manual
  • 11– Linked GQ
  • 14– User file
  • 255 – Any

Default value is 255 - Any

DataView Integer No

Returns/sets the type of data view shown in the FMS Configuration control.

Possible values for this property are as follows.

  • 0 – Configuration
  • 1 – Gas Analysis

Default value is 0 - Configuration

DateFormat

Integer

No

Returns/sets the format of the dates shown in the FMS Configuration control.

Possible values for this property are as follows.

  • 0 – Device time
  • 1 – Contract time
  • 2 – Local time

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is 0 - Device time

DecimalPrecision

Integer

No

Returns/sets the number of decimal places that will be shown in the values displayed by the FMS Configuration control.

Acceptable values include 0 -10 decimal places.

Default value is 7

EndDate

String

No

Returns/sets the ending date of the FMS Configuration control.

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is T

FilterConfigXml

String

No

Returns/sets the XML specifying the filter for the data that will be displayed in the FMS Configuration control.  Another way to configure this property is to use the OCX Properties dialog box (Configuration page). 

See Configure Filter in the Using the Configuration Control topic for more information about the filter settings.

Font

StdFont

No

Returns/sets the font used by the FMS Configuration control. Click to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

IsEditing

Boolean

Yes

Returns whether or not the user is currently editing data in the FMS Configuration control.

PITDateTime

String

No

Returns/sets the Point in Time date and time of the FMS Configuration control. 

This string can be in one of the following forms.

  • Absolute Date/Time (for example, 1/31/2019 7:10:14 AM)
  • Relative Date/Time (for example, y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day, which is an offset from the current day T (for example, T-10)

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

Note: This property is only used if the UsePIT property is set to 1 - Yes.

SessionBeginDate

String

No

Returns/sets the Session starting date for the time window displayed in the control. 

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UsePIT property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionDateFormat

Integer

No

Returns/sets the Session date/time format for the time window displayed in the control.

Possible values for this property are as follows.

  • 0 – Device time
  • 1 – Contract time
  • 2 – Local time

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionEndDate

String

No

Returns/sets the Session ending date for the time window displayed in the control.

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionNodeTag

String

No

Returns/sets the Session Node tag, which specifies the active Node in the FMS Configuration control. 

This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540).

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

ShadingBackColor

OLE_COLOR

No

Returns/sets the color of the cells in the FMS Configuration control. 

See Context Menu for your data view for more information about this property.

Default value is 255.250.205 (pale yellow)

ShadingForeColor

OLE_COLOR

No

Returns/sets the color of the text in the FMS Configuration control. 

See Context Menu for your data view for more information about this property.

Default value is 0.0.0 (black)

ShowChooserPane

Boolean

No

Returns/sets whether or not the Chooser pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowShading Integer No

Returns/sets which parts of the cells will be shaded with color.

Possible values for this property are as follows.

  • 0 - None
  • 1 - Shade foreground (text) only
  • 2 - Shade background (cell) only
  • 3 - Shade both text and cell

See Context Menu for your data view for more information about this property.

Default value is 3 - Shade both text and cell

UnitSet

String

No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS Configuration control.  Another way to configure this property is to use either the control’s property page or to use the Options pane.

Default value is the <Default> unit set, or as configured

UseFilterConfig Boolean No

Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

UsePIT

Boolean

No

Returns/sets whether or not the PITDateTime property will be used.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No

UseSessionNode

Boolean

No

Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS Configuration control.  If this property is set to 0 - No, the FMS Configuration control will present a Chooser page for selection of the active Node.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

Note: The Use Session Node property default value is 1 - Yes/True for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data). The property default value is 0 - No/False for Summary controls (Dashboard, Exceptions) and Admin controls (Balance, Jobs; not applicable to Close Period, PPA).

UseSessionOptions

Boolean

No

Returns/sets whether or not the SessionBeginDate, SessionEndDate, and SessionDateFormat properties will be used in place of the BeginDate, EndDate, and DateFormat properties.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

Note: The Use Session Node property default value is 1 - Yes/True for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data). The property default value is 0 - No/False for Summary controls (Dashboard, Exceptions) and Admin controls (Balance, Jobs; not applicable to Close Period, PPA).

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.